[Doc] gtk_symbolic_color_resolve()'s props arg can be NULL
authorMilan Bouchet-Valat <nalimilan@club.fr>
Sat, 8 Jan 2011 16:25:39 +0000 (17:25 +0100)
committerMilan Bouchet-Valat <nalimilan@club.fr>
Sat, 8 Jan 2011 16:30:45 +0000 (17:30 +0100)
Document this behavior and add annotations.

gtk/gtksymboliccolor.c

index 2345cfa3961c39db3cf2fb98f397973297754643..ee7b714550a1299b9e37bdb44882865132079f75 100644 (file)
@@ -465,7 +465,8 @@ _shade_color (GdkRGBA *color,
 /**
  * gtk_symbolic_color_resolve:
  * @color: a #GtkSymbolicColor
- * @props: #GtkStyleProperties to use when resolving named colors
+ * @props: (allow-none): #GtkStyleProperties to use when resolving
+ *    named colors, or %NULL
  * @resolved_color: (out): return location for the resolved color
  *
  * If @color is resolvable, @resolved_color will be filled in
@@ -473,6 +474,9 @@ _shade_color (GdkRGBA *color,
  * if @color can't be resolved, it is due to it being defined on
  * top of a named color that doesn't exist in @props.
  *
+ * @props must be non-%NULL if @color was created using
+ * gtk_symbolic_color_named_new(), but can be omitted in other cases.
+ *
  * Returns: %TRUE if the color has been resolved
  *
  * Since: 3.0